Skip to main content

Get user profile

GET /api/v1/Profiles/info

Description​

This endpoint retrieves information about a user's profile.

Tags: Profiles

URL:
/api/v{version}/Profiles/info

ApiKey:
No API key required

Content-Type:
No request body

Query Parameters:
version: string, required
Accept-Language: header, optional, change the default response message language from English(en) to French(fr) or English(en)

Request Body:
No request body

Response:
Success, returns a KycResponseResponse object containing information about the user's profile.

Error Codes:
400: Bad Request
404: Not Found

/api/v1/Profiles/info

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Accepttext/plain

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "tier": `<string>`,
    "name": `<string>`,
    "tenantId": `<uuid>`,
    "ownerId": `<uuid>`,
    "approved": `<boolean>`,
    "isTenant": `<boolean>`,
    "isAddressVerified": `<boolean>`,
    "approvedOn": `<dateTime>`,
    "bvn": `<string>`,
    "status": `<string>`
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/Profiles/info \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!